/**
 *    Copyright 2009-2019 the original author or authors.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package org.apache.ibatis.session;

import java.io.IOException;
import java.io.InputStream;
import java.io.Reader;
import java.util.Properties;

import org.apache.ibatis.builder.xml.XMLConfigBuilder;
import org.apache.ibatis.exceptions.ExceptionFactory;
import org.apache.ibatis.executor.ErrorContext;
import org.apache.ibatis.session.defaults.DefaultSqlSessionFactory;

/**
 * 主要用于创建SqlSessionFactory，采用建造者模式
 *
 * 该类提供了三种创建SqlSessionFactory的方法：
 *   1、通过 Reader 创建
 *   2、通过 InputStream 创建
 *   3、使用 Configuration 创建
 *
 * 通过 Reader 和 InputStream 的方式，这两种主要在于读取配置文件的方式不一样，
 * 体现在创建XMLConfigBuilder对象不一致，进一步在于创建XPathParser对象的方式有差别。
 * 实际上，最终这两种均是利用 Configuration 对象创建SqlSessionFactory，
 * 本质上，这些方法均是通过XML配置文件的方法创建SqlSessionFactory
 * 也就是，还可以通过代码的方式创建SqlSessionFactory
 *
 * 创建SqlSessionFactory，大体上可分为两步：
 *   1、通过XMLConfigBuilder解析Mybatis的 XML 配置文件，将解析到的配置信息保存到Configuration对象中
 *   2、使用Configuration对象创建SqlSessionFactory
 *
 * @date: 2019-07-04 14:54
 */

public class SqlSessionFactoryBuilder {

  public SqlSessionFactory build(Reader reader) {
    return build(reader, null, null);
  }

  public SqlSessionFactory build(Reader reader, String environment) {
    return build(reader, environment, null);
  }

  public SqlSessionFactory build(Reader reader, Properties properties) {
    return build(reader, null, properties);
  }

  /**
   * 通过 Reader 创建SqlSessionFactory对象
   * 最终创建一个默认的SqlSessionFactory。
   *
   * @param reader
   * @param environment
   * @param properties
   * @return
   */
  public SqlSessionFactory build(Reader reader, String environment, Properties properties) {
    try {
      /*
       * 创建XMLConfigBuilder对象，也就是在这时Configuration对象也没创建完成(使用默认构造器)
       * 并完成Mybatis内置的别名的注册。此外，还创建了类型处理器，但此时类型处理器还是空的。
       * 同时，将传入的Properties对象，保存到Configuration中。
       */
      XMLConfigBuilder parser = new XMLConfigBuilder(reader, environment, properties);
      /*
       * 解析Mybatis配置文件，将解析到的信息保存到Configuration对象中，
       * mybatis只会解析一次配置文件，如果多次解析会抛出异常，也就是刚刚创建的XMLConfigBuilder对象
       * 只能配只用一次。
       * 至于，为什么只能使用一次，还没想明白，希望以后看得更深了能够想明白。
       */
      return build(parser.parse());
    } catch (Exception e) {
      throw ExceptionFactory.wrapException("Error building SqlSession.", e);
    } finally {
      ErrorContext.instance().reset();
      try {
        reader.close();
      } catch (IOException e) {
        // Intentionally ignore. Prefer previous error.
      }
    }
  }

  public SqlSessionFactory build(InputStream inputStream) {
    return build(inputStream, null, null);
  }

  public SqlSessionFactory build(InputStream inputStream, String environment) {
    return build(inputStream, environment, null);
  }

  public SqlSessionFactory build(InputStream inputStream, Properties properties) {
    return build(inputStream, null, properties);
  }

  /**
   * 通过 InputStream 创建SqlSessionFactory对象
   *
   * @param inputStream
   * @param environment
   * @param properties
   * @return
   */
  public SqlSessionFactory build(InputStream inputStream, String environment, Properties properties) {
    try {
      XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);
      return build(parser.parse());
    } catch (Exception e) {
      throw ExceptionFactory.wrapException("Error building SqlSession.", e);
    } finally {
      ErrorContext.instance().reset();
      try {
        inputStream.close();
      } catch (IOException e) {
        // Intentionally ignore. Prefer previous error.
      }
    }
  }

  /**
   * 利用Configuration对象创建一个默认的SqlSessionFactory对象
   *
   * @param config
   * @return
   */
  public SqlSessionFactory build(Configuration config) {
    return new DefaultSqlSessionFactory(config);
  }

}
